home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / pc_board / dms35a.zip / WGM-DMS.DOC < prev    next >
Text File  |  1992-05-26  |  40KB  |  823 lines

  1.  
  2.  
  3.                                 WGM-DMS v.3.5
  4.  
  5.                       The Directory Manipulation System
  6.  
  7.                              for PCBoard v.14.x
  8.  
  9.  
  10.                     Copyright(C) 1988,92 - Wayne G. Maas
  11.  
  12.                                 Wayne G. Maas
  13.                             880 Farmington Ave #202
  14.                             West Hartford, CT 06119
  15.  
  16.                             Support is available on:
  17.  
  18.                         Innovative Computer Services BBS
  19.                                (516) 226-3727
  20.  
  21.  
  22.  
  23. ┌───────────────────┐
  24. │  1. Introduction  │
  25. └───────────────────┘
  26.  
  27.         WGM-DMS, which stands for Directory Manipulation System and will be
  28.         referred through out this document as WGM-DMS, is a utility for sysops
  29.         that use PCBoard(tm) version 14.x.  This software will manipulate and
  30.         massage PCBoard directory files making them more appealing. WGM-DMS
  31.         has been around for almost 4 years, starting with version 2.0 that was
  32.         released March 1988, and has gone through some major enhancements and
  33.         revisions along the way.  This current version of WGM-DMS is written
  34.         in Turbo Pascal 6.0 by Borland International using Object Professional
  35.         by TurboPower Software 1.10.
  36.  
  37.  
  38. ┌──────────────────────────┐
  39. │  2. Features of WGM-DMS  │
  40. └──────────────────────────┘
  41.  
  42.         ∙   Create directory headers that summarize your downloadable file
  43.             directories.
  44.         ∙   Directory headers can make use of PCBoard v.14.a detachable
  45.             headers.
  46.         ∙   Process headers for any combination of conferences or none at all.
  47.         ∙   Ability to select 1 of 6 header styles.
  48.         ∙   Create conference file directories that summarize downloadable
  49.             files.
  50.         ∙   Create up to 99 bulletin files.
  51.         ∙   Ability to select 1 of 2 bulletin styles.
  52.         ∙   Create up to 99 master file listings.
  53.         ∙   Ability to create complete listings as well as new files since a
  54.             certain date.
  55.         ∙   Master file listings can be split into multiple files for smaller
  56.             downloadable files for your users.
  57.         ∙   Can compress listings using ZIP,ARC,ARJ,PAK,LZH and ZOO.
  58.         ∙   Compressed master file listings can have comments added.
  59.         ∙   Optional Log file (summarized or detailed) that will track
  60.             processing.
  61.         ∙   Will backup all files before processing.
  62.         ∙   Ability to store backups in a separate directory.
  63.         ∙   Ability to show private directories.
  64.         ∙   Insert optional unique or global text files into any text file
  65.             processed.
  66.         ∙   Text files that are inserted can be unique or the same text file.
  67.         ∙   Desqview compatible.
  68.  
  69.  
  70. ┌───────────────────────────────────────┐
  71. │  3. Files in the distributed archive  │ 
  72. └───────────────────────────────────────┘
  73.  
  74.         WGM-DMS.EXE               The sysop utility program.
  75.         WGM-DMS.CFG               Example of the configuration needed.
  76.         WGM-DMS.DOC               This file
  77.         FILE_ID.DIZ               Text file that describes this utility.
  78.         REGISTER.FRM              Registration form for WGM-DMS.
  79.         README.NOW                Any last minute information.
  80.  
  81.         If there are any files missing or addition, the archive has been
  82.         tampered with and you should deleted.  Please contact the support BBS
  83.         to download the latest version of the utility.
  84.  
  85.  
  86. ┌───────────────────┐
  87. │  4. Requirements  │ 
  88. └───────────────────┘ 
  89.  
  90.         WGM-DMS requires the following:
  91.  
  92.             IBM PC/XT/AT, PS/2 or 100% compatible machine.
  93.             At least 384k of memory (the more the better).
  94.             MS or PC-DOS v.3.1 or later.
  95.             PCBoard v.14.x or later.
  96.  
  97.         WGM-DMS does read and write files with SHARE compatibility. To ensure
  98.         100% data integrity and efficiency, I would recommend all of your
  99.         system's nodes be down.
  100.  
  101.  
  102. ┌───────────────────┐
  103. │  5. Registration  │ 
  104. └───────────────────┘ 
  105.  
  106.         If you register WGM-DMS you will get a registration code that will
  107.         remove the 15 second screen in the beginning and ending of the
  108.         program.  The registration code will be valid for all future versions
  109.         of WGM-DMS.  In addition to the registration code, you will also have
  110.         access to download the latest version on the support BBS.
  111.  
  112.         The registration fee for your unique registration code is $15.  This
  113.         fee has been reduced by $10.00 from version 3.3/4.  The reason for
  114.         this is to generate more interest in it since a few other programs
  115.         have been released that TRY to accomplish the same thing.
  116.  
  117.         Please print the file REGISTER.FRM and fill it out. You can print out
  118.         the form by issuing the following command from the DOS prompt:
  119.  
  120.         TYPE REGISTER.FRM > PRN
  121.  
  122.  
  123. ┌───────────────────────────────────────┐
  124. │  6. License, Warranty and Disclaimer  │
  125. └───────────────────────────────────────┘
  126.  
  127.         License:                  You are allowed to use WGM-DMS until you see
  128.                                   fit, after which you should register it or
  129.                                   stop using.
  130.  
  131.         Warranty:                 There isn't one. The only thing I'll
  132.                                   guarantee is that WGM- DMS will take up disk
  133.                                   space.
  134.  
  135.         Disclaimer:               I'm not responsible for anything bad that
  136.                                   happens. WGM-DMS works here, but I cannot be
  137.                                   held responsible for it not working on your
  138.                                   computer or doing any damage to hardware or
  139.                                   software.  All I can say is back everything
  140.                                   up before attempting to run it.
  141.  
  142.  
  143. ┌───────────────────┐
  144. │  7. Installation  │
  145. └───────────────────┘
  146.  
  147.         Make a subdirectory on your hard drive.  Unarchive the WGM-DMS
  148.         distribution archive into this subdirectory.
  149.  
  150.         Edit the configuration file to suit your needs. Proper configuration
  151.         will require you to refer to this section and the section titled
  152.         "Configuration", which has an in-depth explanation of the
  153.         configuration parameters and their functions. It would probably be
  154.         wise to print this document if you haven't already.
  155.  
  156.         For this document, we'll assume the name of your configuration file is
  157.         "WGM-DMS.CFG".
  158.  
  159. ┌────────────────────┐
  160. │  9. Configuration  │
  161. └────────────────────┘
  162.  
  163.         WGM-DMS does not have a setup or install utility that will make this
  164.         painless for you.  Since you will probably edit this file ONCE or when
  165.         you alter your bulletin board system so I didn't bother writing a
  166.         setup program.  I wanted to put all my efforts into the actual program
  167.         instead of something that will be run once in a blue moon.
  168.  
  169.         WGM-DMS uses a text file that contains all the information it needs to
  170.         run.  The sample configuration file included is heavily commented.
  171.         Below are all the options explained below:
  172.  
  173.         SYSOP=
  174.                  This is the sysop name that has been indicated on the
  175.                  registration form.  This is use to generate the registration
  176.                  code.  Any variation of this from the one submitted will be
  177.                  determined as an invalid registration number.
  178.  
  179.         REGCODE=
  180.                  This is the registration code indicated on the registration
  181.                  letter that you will receive upon registering the software.
  182.                  This should be typed in exactly as it appears on the letter.
  183.                  Any variation of this from the one submitted will be
  184.                  determined as an invalid registration number.
  185.  
  186.         BBSNAME=
  187.                  This is the name of your bulletin board system.  This can be
  188.                  a name of your choice and up to 75 characters long.  Anything
  189.                  longer will be truncated.  This is not used in any to
  190.                  determine the a valid registration number.
  191.  
  192.         PCBOARD=
  193.                  This is the name of the drive,path and/or location of the
  194.                  PCBOARD.DAT file of your system.
  195.  
  196.         BACKUP=
  197.                  This will allow WGM-DMS to backup (or not) any file processed
  198.                  prior to any alterations that will take place.  This entry
  199.                  can be a YES or a NO entry. YES if you want backups or NO if
  200.                  you do not.  I highly recommend that this be used.
  201.  
  202.         BACKUPPATH=
  203.                  This is a directory of your choice where you want to place
  204.                  all the backups WGM-DMS creates.  If it doesn't exist,
  205.                  WGM-DMS will create it.  Since there is only one backup
  206.                  directory, a particular naming convention is used not to have
  207.                  any files overwritten.
  208.  
  209.         USELOG=
  210.                  This will allow WGM-DMS to output all activity to a log file.
  211.                  This is very useful when trying to determine a problem that
  212.                  may arise, or just to track what is processed each time.
  213.                  This entry can be a YES or a NO entry. YES if you want to use
  214.                  the log file or NO if you do not.  If speed is a real concern
  215.                  to you, you can comment this line out (or delete it).  This
  216.                  will make WGM-DMS operate faster since there is no writing to
  217.                  a disk file.
  218.  
  219.         LOGFILE=
  220.                  This is the drive,path and/or filename of the log file where
  221.                  WGM-DMS will output it's activity.  This needs to be a valid
  222.                  DOS filename (up to 64 characters) and if it doesn't exist,
  223.                  it will be created.
  224.  
  225.  
  226.         SHOWPRIVATE=
  227.                  This will allow you to include or exclude an entry for your
  228.                  PRIVATE upload directories.  This entry can be a YES or a NO
  229.                  entry. YES if you want to include the number of files and
  230.                  bytes or NO to exclude them.  If this is set to YES, the
  231.                  files and bytes will only appear in the conference
  232.                  directories and bulletin files and will not display the
  233.                  actual contents anywhere.  They are NOT included in the
  234.                  master file listings.
  235.  
  236.         INSERTPATH=
  237.                  This is a drive and/or path to contain the text files that
  238.                  WGM-DMS will insert into the directory headers, conference
  239.                  directories and bulletins.  If this is not specified (or
  240.                  commented out) WGM-DMS will look in the default directory
  241.                  that WGM-DMS was executed from.  WGM- DMS uses different text
  242.                  filenames based on what portion of the program is doing the
  243.                  inserting.
  244.  
  245.                  ┌──────────────────────┐
  246.                  │File directory headers│
  247.                  └──────────────────────┘
  248.  
  249.                  If you want to insert text files into directory headers, you
  250.                  can have a unique text file inserted into each header or one
  251.                  text file that will be inserted into all headers.  If you
  252.                  want to insert a unique text file, you need to follow a
  253.                  simple naming convention.  It is DRXaaaaa.bbb where the
  254.                  (aaaaa) is the number of the conference and where (bbb) is
  255.                  the number of the file directory as PCBoard would recognize
  256.                  it.  Both (aaaaa) and (bbb) need to have leading zeros.
  257.  
  258.                  For example, if you want a specific text file inserted into
  259.                  Conference 1, directory 5 you need to have a file by the name
  260.                  of DRX00001.005.  That's it.  With this type of naming
  261.                  convention, you can have text files up to the 65000+
  262.                  conferences allowed in PCBoard and up to 999 file directories
  263.                  within each conference.
  264.  
  265.                  If you want a specific text file inserted into only one
  266.                  conference, but all file directories, all you need to do is
  267.                  create a text file following the naming convention above but
  268.                  leave off the extension.
  269.  
  270.                  For example, if you want a specific text file inserted into
  271.                  Conference 1, but for all file directories, you need to have
  272.                  a file with the name of DRX00001.  That's it.
  273.  
  274.                  If you don't want a specific text file inserted but want one
  275.                  text file inserted into all directory headers, just create a
  276.                  file with the name DRXINSRT.TXT.  WGM-DMS will insert this if
  277.                  it is found in the insert path specified.
  278.  
  279.                  Please note that WGM-DMS will first look for the unique text
  280.                  file.  If that is not found, then WGM-DMS will look for one
  281.                  with the global naming convention.  If none are found, it is
  282.                  skipped and nothing is inserted.
  283.  
  284.                  ┌────────────────────────────────┐
  285.                  │Conference directory (DIR) files│
  286.                  └────────────────────────────────┘
  287.  
  288.                  If you want to insert text files into conference directory
  289.                  files, you can have a unique text file inserted for each
  290.                  conference or one text file that will be inserted into all
  291.                  conference directory files.  If you want to insert a unique
  292.                  text file, you need to follow the same naming convention as
  293.                  for directory headers but with a slight variation.  It is
  294.                  DIRaaaaa. where the (aaaaa) is the number of the conference.
  295.                  The (aaaaa) needs to have leading zeros.
  296.  
  297.                  For example, if you want a specific text file inserted into
  298.                  the Conference 1, directory file you need to have a file by
  299.                  the name of DIR00001.  That's it.
  300.  
  301.                  If you don't want a specific text file inserted but want one
  302.                  text file inserted into all conference directory files, just
  303.                  create a file with the name DIRINSRT.TXT.  WGM-DMS will
  304.                  insert this if it is found in the insert path specified.
  305.  
  306.                  ┌──────────────┐
  307.                  │Bulletin files│
  308.                  └──────────────┘
  309.  
  310.                  If you want to insert text files into bulletin files that
  311.                  WGM- DMS creates, you can have a unique text file inserted
  312.                  for each bulletin or one text file that will be inserted into
  313.                  all bulletin files.  If you want to insert a unique text
  314.                  file, you need to follow the same naming convention as for
  315.                  directory headers and conference directory files but with a
  316.                  slight variation.  It is BLTaaaaa. where the (aaaaa) is the
  317.                  number of the bulletin file created.  The (aaaaa) needs to
  318.                  have leading zeros.
  319.  
  320.                  For example, if you want a specific text file inserted into
  321.                  bulletin 1 you need to have a file with the name of BLT00001.
  322.                  That's it.
  323.  
  324.                  If you don't want a specific text file inserted but want one
  325.                  text file inserted into all bulletin files, just create a
  326.                  file with the name BLTINSRT.TXT.  WGM-DMS will insert this if
  327.                  it is found in the insert path specified.
  328.  
  329.                  See the explanation of bulletins for additional information
  330.                  on how they are numbered.
  331.  
  332.  
  333.         The remaining keywords explained here will be grouped by function.
  334.         The first 3 characters indicate the group.  HDR indicates directory
  335.         headers, DIR indicates conference directory files, BLT indicates
  336.         bulletin files and LST indicates master listing files.
  337.  
  338.         Anytime this configuration file calls for a color code, this refers to
  339.         the PCBoard @Xyx color codes.  The color code is in the format of @Xyz
  340.         where y represents a hexadecimal value for the background color and z
  341.         represents a hexadecimal value for the foreground color, both in a
  342.         range of 0-F. Below is a chart of the colors.
  343.  
  344.             BACKGROUND (first digit)           FOREGROUND (second digit)
  345.             Black            = 0               Black            = 0
  346.             Blue             = 1               Blue             = 1
  347.             Green            = 2               Green            = 2
  348.             Cyan             = 3               Cyan             = 3
  349.             Red              = 4               Red              = 4
  350.             Magenta          = 5               Magenta          = 5
  351.             Yellow           = 6               Yellow           = 6
  352.             White            = 7               White            = 7
  353.  
  354.             BACKGROUND with Blinking           High Intensity Foregrounds
  355.             Black            = 8               Black            = 8
  356.             Blue             = 9               Blue             = 9
  357.             Green            = A               Green            = A
  358.             Cyan             = B               Cyan             = B
  359.             Red              = C               Red              = C
  360.             Magenta          = D               Magenta          = D
  361.             Yellow           = E               Yellow           = E
  362.             White            = F               White            = F
  363.  
  364.  
  365.         The keywords that are described next apply towards the creation of
  366.         directory headers.  They are described as follows:
  367.  
  368.         HDRPROCESS=
  369.                  This tells WGM-DMS which conferences to process and create
  370.                  directory headers for.  This can be indicated several ways.
  371.                  You can indicate the conferences by stating individual
  372.                  conferences such as 1,2,3,4,5 or by stating a range such as
  373.                  1-5.  You can mixed the way you indicate the conferences such
  374.                  as 1-5,10,20,25-30.  These are all valid.  If you wish to
  375.                  process all file directories in all conferences you can
  376.                  specify ALL as a conference.  This will process all
  377.                  conferences.
  378.  
  379.         HDRDETACHABLE=
  380.                  This tells WGM-DMS to use the detachable headers option of
  381.                  PCBoard v.14.5a so PCBFiler won't screw up the directory
  382.                  headers.  This uses the %FILESPEC option in PCBoard v.14.5a.
  383.                  If you are not running PCBoard 14.5a then set this to NO.
  384.                  This will create the headers at the top of the directory
  385.                  file.
  386.  
  387.         HDRDETACHPATH=
  388.                  This is the drive, path and/or filename in which you want to
  389.                  store all of the directory headers for PCBoard that WGM-DMS
  390.                  creates.  WGM-DMS uses a naming convention that will not
  391.                  overwrite headers of the same names that are in different
  392.                  conferences.  If the directory doesn't exist, WGM-DMS will
  393.                  attempt to create it.  If an error is encountered WGM-DMS
  394.                  will place the headers in the directory where the PCBoard
  395.                  directory files are stored.
  396.  
  397.         HDRSTYLE=
  398.                  This entry is a number in the range of 1-6. This will allow
  399.                  you to select one of the canned styles that WGM-DMS uses.
  400.  
  401. Style 1:
  402. ╒═══════════════════════════════════════════════════════════════════════════╕
  403. │                         Bulletin Board System Name                        │
  404. │               Conference Name ■ File Directory Description                │
  405. ╞═══════════════════════════════════════════════════════════════════════════╡
  406. ├──────────────────┤ Last updated on 99/99/99 at 99:99 xx ├─────────────────┤
  407. ╞═══════════════════════════════════════════════════════════════════════════╡
  408. │                            On-line           Off-line            Deleted  │
  409. │   Number of files: 999,999,999,999    999,999,999,999    999,999,999,999  │
  410. │   Number of bytes: 999,999,999,999    999,999,999,999    999,999,999,999  │
  411. ╞════════════╤═══════╤══════════╤═══════════════════════════════════════════╡
  412. │  Filename  │ Size  │   Date   │ File Description            WGM-DMS v.9.9 │
  413. ╘════════════╧═══════╧══════════╧═══════════════════════════════════════════╛
  414.  
  415. Style 2:
  416. ╒═══════════════════════════════════════════════════════════════════════════╕
  417. │                         Bulletin Board System Name                        │
  418. │                Conference Name ■ File Directory Description               │
  419. ├───────────────────────────────────────────────────────────────────────────┤
  420. ├──────────────────┤ Last updated on 99/99/99 at 99:99 xx ├─────────────────┤
  421. ├───────────────────────────────────────────────────────────────────────────┤
  422. │                            On-line           Off-line              Total  │
  423. │   Number of files: 999,999,999,999    999,999,999,999    999,999,999,999  │
  424. │   Number of bytes: 999,999,999,999    999,999,999,999    999,999,999,999  │
  425. ╞════════════╤═══════╤══════════╤═══════════════════════════════════════════╡
  426. │ File Name  │ Size  │   Date   │ File Description            WGM-DMS v.9.9 │
  427. ╘════════════╧═══════╧══════════╧═══════════════════════════════════════════╛
  428.  
  429. Style 3:
  430. ╒═══════════════════════════════════════════════════════════════════════════╕
  431. │                        Bulletin Board System Name                         │
  432. ╞═════════╤═════════════════════════════════════════════════════════════════╡
  433. │ Dir 999 │ File Directory Description                                      │
  434. ├─────────┴─────────────┬───────────────────────┬───────────────────────────┤
  435. │ Files:999,999,999,999 │ Bytes:999,999,999,999 │ As of:99/99/99 @ 99:99 xx │
  436. ╞════════════╤═══════╤══╧═══════╤═══════════════╧═══════════════════════════╡
  437. │ File Name  │ Size  │   Date   │ File Description            WGM-DMS v.9.9 │
  438. ╘════════════╧═══════╧══════════╧═══════════════════════════════════════════╛
  439.  
  440. Style 4:
  441. ╒═══════════════════════════════════════════════════════════════════════════╕
  442. │ Bulletin Board System Name                         Files: 999,999,999,999 │
  443. │ Conference Name Directory 999                      Bytes: 999,999,999,999 │
  444. │ File Directory Description                         Updated on:   99/99/99 │
  445. ├───────────────────────────────────────────────────────────────────────────┤
  446. │ File Name      Size    Date    File Description             WGM-DMS v.9.9 │
  447. ╘═══════════════════════════════════════════════════════════════════════════╛
  448.  
  449. Style 5:
  450. ╒═══════════════════════════════════════════════════════════════════════════╕
  451. │                        Bulletin Board System Name                         │
  452. │               Conference Name ■ File Directory Description                │
  453. ├───────────────────────────────────────────────────────────────────────────┤
  454. │999,999,999,999 files using 999,999,999,999 bytes as of 99/99/99 at 99:99xx│
  455. ├───────────────────────────────────────────────────────────────────────────┤
  456. │ File Name      Size    Date    File Description             WGM-DMS v.9.9 │
  457. ╘═══════════════════════════════════════════════════════════════════════════╛
  458.  
  459. Style 6:
  460.  
  461.                          Bulletin Board System Name
  462.                  Conference Name - File Directory Description
  463.  
  464.               999,999,999,999 files using 999,999,999,999 bytes
  465.  
  466.                     Last Updated on: 99/99/99 at 99:99 xx
  467.  
  468.  File Name      Size     Date     File Description              WGM-DMS v.9.9
  469. -----------   -------- --------  --------------------------------------------
  470.  
  471.  
  472.         HDRFRAME=
  473.                  This is the color code that will be used to color the frame
  474.                  of the directory header.
  475.  
  476.         HDRBOARD=
  477.                  This is the color code that will be used to color the
  478.                  bulletin board system name in the directory header.
  479.  
  480.         HDRDESCR=
  481.                  This is the color code that will be used to color the file
  482.                  directory description in the directory header.
  483.  
  484.         HDRTEXTS=
  485.                  This is the color code that will be used to color the
  486.                  additional text in the directory header.
  487.  
  488.         HDRSTATS=
  489.                  This is the color code that will be used to color the numeric
  490.                  values of the files and bytes in the directory header.
  491.  
  492.         HDRSTAMP=
  493.                  This is the color code that will be used to color the time
  494.                  and date stamp in the directory header.
  495.  
  496.  
  497.         The keywords that are described next apply towards the creation of
  498.         conference directory files.  They are described as follows:
  499.  
  500.         DIRPROCESS=
  501.                  This tells WGM-DMS which conferences to process and create
  502.                  conference directory files for. This can be indicated several
  503.                  ways.  You can indicate the conferences by stating individual
  504.                  conferences such as 1,2,3,4,5 or by stating a range such as
  505.                  1-5.  You can mixed the way you indicate the conferences such
  506.                  as 1-5,10,20,25-30.  These are all valid.  If you wish to
  507.                  process all file directories in all conferences you can
  508.                  specify ALL as a conference.  This will process all
  509.                  conferences.
  510.  
  511.         DIRFRAME=
  512.                  This is the color code that will be used to color the frame
  513.                  of the conference directory file header.
  514.  
  515.         DIRBOARD=
  516.                  This is the color code that will be used to color the
  517.                  bulletin board system name in the conference directory file
  518.                  header.
  519.  
  520.         DIRDESCR=
  521.                  This is the color code that will be used to color the file
  522.                  directory description in the conference directory file
  523.                  header.
  524.  
  525.         DIRTEXTS=
  526.                  This is the color code that will be used to color the
  527.                  additional text in the conference directory file header.
  528.  
  529.         DIRSTATS=
  530.                  This is the color code that will be used to color the numeric
  531.                  values of the files and bytes in the conference directory
  532.                  header.
  533.  
  534.         DIRSTAMP=
  535.                  This is the color code that will be used to color the time
  536.                  and date stamp in the conference directory header.
  537.  
  538.  
  539.         DIRDIRNO=
  540.                  This is the color code that will be used to color the file
  541.                  directory number within the main body of the conference
  542.                  directory file.
  543.  
  544.         DIRDIRTX=
  545.                  This is the color code that will be used to color the file
  546.                  directory description within the main body of the conference
  547.                  directory file.
  548.  
  549.         DIRFILES=
  550.                  This is the color code that will be used to color the number
  551.                  of files for each file directory within the main body of the
  552.                  conference directory file.
  553.  
  554.         DIRBYTES=
  555.                  This is the color code that will be used to color the number
  556.                  of bytes for each file directory within the main body of the
  557.                  conference directory file.
  558.  
  559.  
  560.         The keywords that are described next apply towards the creation of
  561.         bulletin files.  You can have up to 99 individual bulletin files that
  562.         can be any combination of conferences on your system.  In order to
  563.         create the bulletin files, the are 3 required keywords that need to be
  564.         grouped together for WGM- DMS to work correctly.  They are described
  565.         as follows:
  566.  
  567.         BLTFNAME=
  568.                  This is the drive,path and/or filename of the bulletin file
  569.                  you want to create.
  570.  
  571.         BLTPROCESS=
  572.                  This tells WGM-DMS which conferences to process and include
  573.                  for the bulletin file above. This can be indicated several
  574.                  ways.  You can indicate the conferences by stating individual
  575.                  conferences such as 1,2,3,4,5 or by stating a range such as
  576.                  1-5.  You can mixed the way you indicate the conferences such
  577.                  as 1-5,10,20,25-30.  These are all valid.  If you wish to
  578.                  process all file directories in all conferences you can
  579.                  specify ALL as a conference.  This will process all
  580.                  conferences.
  581.  
  582.         BLTSTYLE=
  583.                  This entry is a number in the range of 1-2. This will allow
  584.                  you to select one of the canned styles that WGM-DMS uses.
  585.                  Currently there are only 2 (1 for detailed, 2 for summary)
  586.                  but may be expanded in future versions.
  587.  
  588.  
  589.         To create more than one bulletin file, you will need to take the 3
  590.         keywords above and specify them again making sure the BLTFNAME=
  591.         filename is different than the previous one specified or WGM- DMS will
  592.         overwrite the previously created bulletin.  For example, to create 3
  593.         bulletin files for your system, you need 3 groups of keywords in the
  594.         configuration file such as:
  595.  
  596.                  BLTFNAME=c:\pcb\blts\blt01
  597.                  BLTPROCESS=0
  598.                  BLTSTYLE=1
  599.  
  600.                  BLTFNAME=c:\pcb\blts\blt02
  601.                  BLTPROCESS=1
  602.                  BLTSTYLE=2
  603.  
  604.                  BLTFNAME=c:\pcb\blts\blt03
  605.                  BLTPROCESS=2
  606.                  BLTSTYLE=1
  607.  
  608.         In the above example, the first set will create a detail bulletin with
  609.         the name of C:\PCB\BLTS\BLT01 for conference 0.  The second set will
  610.         create a summarized bulletin with the name of C:\PCB\BLTS\BLT02 for
  611.         conference number 1. Finally, the third set will create a detailed
  612.         bulletin file with the name of C:\PCB\BLTS\BLT03 for conference 2.
  613.  
  614.         You can have up to 99 sets of these keywords.
  615.  
  616.         BLTFRAME=
  617.                  This is the color code that will be used to color the frame
  618.                  of the bulletin file header.
  619.  
  620.         BLTBOARD=
  621.                  This is the color code that will be used to color the
  622.                  bulletin board system name in the bulletin file header.
  623.  
  624.         BLTTEXTS=
  625.                  This is the color code that will be used to color the
  626.                  additional text in the bulletin file header.
  627.  
  628.         BLTSTATS=
  629.                  This is the color code that will be used to color the numeric
  630.                  values of the files and bytes in the bulletin file footer.
  631.  
  632.         BLTSTAMP=
  633.                  This is the color code that will be used to color the time
  634.                  and date stamp in the bulletin file header.
  635.  
  636.         BLTCNAME=
  637.                  This is the color code that will be used to color the
  638.                  conference name within the main body of the bulletin file.
  639.  
  640.         BLTDIRNO=
  641.                  This is the color code that will be used to color the file
  642.                  directory number within the main body of the bulletin file.
  643.  
  644.         BLTDIRTX=
  645.                  This is the color code that will be used to color the file
  646.                  directory description within the main body of the bulletin
  647.                  file.
  648.  
  649.         BLTFILES=
  650.                  This is the color code that will be used to color the number
  651.                  of files for each file directory within the main body of the
  652.                  bulletin file.
  653.  
  654.         BLTBYTES=
  655.                  This is the color code that will be used to color the number
  656.                  of bytes for each file directory within the main body of the
  657.                  bulletin file.
  658.  
  659.         The keywords that are described next apply towards the creation of the
  660.         master file listings.  They are described as follows:
  661.  
  662.         LSTCOMMENT=
  663.                  This is the drive,path and/or filename of the text file that
  664.                  WGM-DMS will include in the compressed master file listing as
  665.                  a comment.  This needs to be a valid DOS filename (up to 64
  666.                  characters).
  667.  
  668.         LSTHEADER=
  669.                  This is a character string that will be used at the top of
  670.                  every page in the master file listing that WGM-DMS creates.
  671.                  This can be up to 80 characters.
  672.  
  673.         You can have up to 99 individual master files created that can be of
  674.         any combination of conferences on your system.  In order to create the
  675.         master listings files, the are 5 required keywords that need to be
  676.         grouped together for WGM-DMS to work correctly.  This operates the
  677.         same way you specified the bulletin files.  They are described as
  678.         follows:
  679.  
  680.         LSTFNAME=
  681.                  This is the drive,path and/or filename of the master file
  682.                  listing to create.  DO NOT, repeat DO NOT specify a file
  683.                  extension.  WGM-DMS adds .LST to the file.  If you are
  684.                  creating a master file listing that will be split by the
  685.                  LSTNUMDIRS= keyword, then you can only use the first 5
  686.                  characters for a filename.  WGM-DMS will append to the
  687.                  filename a zero filled value from 000-999 based on the
  688.                  filename being created.
  689.  
  690.         LSTPROCESS=
  691.                  This tells WGM-DMS which conferences to process and include
  692.                  for the master file listing above.  This can be indicated
  693.                  several ways.  You can indicate the conferences by stating
  694.                  individual conferences such as 1,2,3,4,5 or by stating a
  695.                  range such as 1-5.  You can mixed the way you indicate the
  696.                  conferences such as 1-5,10,20,25-30.  These are all valid.
  697.                  If you wish to process all file directories in all
  698.                  conferences you can specify ALL as a conference.  This will
  699.                  process all conferences.
  700.  
  701.         LSTDIRFILE=
  702.                  This is the name of the PCBoard directory text that contains
  703.                  the file's name,size,date and file description.  This is
  704.                  needed so WGM-DMS can correctly update the file date and size
  705.                  when it creates the compressed master file listing.
  706.  
  707.         LSTNUMDIRS=
  708.                  This is a numeric value that you specify to tell WGM-DMS to
  709.                  include a specific number of file directories in each
  710.                  compressed master listing.  This option is what you use to
  711.                  split your file directories into multiple downloadable files.
  712.                  If this is not specified, all file directories are assumed.
  713.                  To disable this feature, set this to a value of 0.
  714.  
  715.         LSTMAXDAYS=
  716.                  This is a numeric value that you use to indicate the number
  717.                  of days from the date WGM-DMS processes to include in the
  718.                  master file listing.  To disable this feature, set this to a
  719.                  value of 0. This is a good way to create a master file
  720.                  listing that contains all files that are (xx) days old on the
  721.                  system.
  722.  
  723.         To create more than one master file listing, you will need to take the
  724.         5 keywords above and specify them again making sure the LSTFNAME=
  725.         filename is different than the previous one specified or WGM-DMS will
  726.         overwrite the previously created master file listing.  For example, to
  727.         create 3 master file listings for your system, you need 3 groups of
  728.         keywords in the configuration file such as:
  729.  
  730.                  LSTFNAME=c:\pcb\uploads\allfiles
  731.                  LSTPROCESS=0
  732.                  LSTDIRFILE=c:\pcb\gen\uploads
  733.                  LSTNUMDIRS=0
  734.                  LSTMAXDAYS=0
  735.  
  736.                  LSTFNAME=c:\pcb\uploads\files
  737.                  LSTPROCESS=0
  738.                  LSTNUMDIRS=1
  739.                  LSTMAXDAYS=0
  740.  
  741.                  LSTFNAME=c:\pcb\uploads\newfiles
  742.                  LSTPROCESS=0
  743.                  LSTNUMDAYS=0
  744.                  LSTMAXDAYS=30
  745.  
  746.         In the above example, the first set will create a master file listing
  747.         called ALLFILES that will contain all file directories of conference 0
  748.         that is described in the C:\PCB\GEN\UPLOADS directory file. The second
  749.         set will create multiple master file listings that begin with FILESxxx
  750.         that will contain 1 directory file per master listing for conference 0
  751.         that is described in C:\PCB\GEN\UPLOADS directory file.  Finally, the
  752.         third set will create a master file listing called NEWFILES that will
  753.         contain files that have been placed on the system within the past 30
  754.         days and are described in the C:\PCB\GEN\UPLOADS directory file.
  755.  
  756.         You can have up to 99 sets of these sets of keywords.
  757.  
  758. ┌───────────────────────┐
  759. │  10. Running WGM-DMS  │
  760. └───────────────────────┘
  761.  
  762.         After you have edited or created a configuration file you will be
  763.         ready to run WGM-DMS.  To have WGM-DMS create directory headers,
  764.         conference directories, bulletins and master file listings all you
  765.         need to do is invoke WGM-DMS by entering:
  766.  
  767.                  WGM-DMS
  768.  
  769.         WGM-DMS also offers some command line options that will either enhance
  770.         or alter the way WGM- DMS functions.  These options are invoked as:
  771.  
  772.                  WGM-DMS [options]
  773.  
  774.         Valid command line options are:
  775.  
  776.                  /c<file>   where <file> is an alternate configuration
  777.                             filename.
  778.  
  779.                  /u         to process only upload directories when creating
  780.                             headers.
  781.  
  782.                  /m         to process only modified directories when creating
  783.                             headers.
  784.  
  785.                  /d         this will add more detail to the test that is
  786.                             outputed to the log file.
  787.  
  788.                  /v<n|m>    this controls the video, n for normal CGA colors
  789.                             and m to run in mono mode.
  790.  
  791.                  /nh        prevents directory headers from being created.
  792.  
  793.                  /nd        prevents conference directory files from being
  794.                             created.
  795.  
  796.                  /nb        prevents bulletin files from being created.
  797.  
  798.                  /nl        prevents master file listings from being created.
  799.  
  800.                  /?         display the help screen.
  801.  
  802.  
  803.         For example, to have WGM-DMS only process modified files (file
  804.         directories that have changed since WGM-DMS last ran) you would invoke
  805.         at the dos prompt:
  806.  
  807.                  WGM-DMS /m
  808.  
  809.  
  810. ┌─────────────────────────┐
  811. │  11. Technical Support  │
  812. └─────────────────────────┘
  813.  
  814.         Anyone who attempts to use WGM-DMS and has trouble can call the
  815.         support bbs and get some help.  This is available to all registered
  816.         and non-registered users. If you are a long distance call from the
  817.         bbs, then check a local board for one that carries the RIME
  818.         WGM-Software conference #184. Support is also handle through that. The
  819.         latest version can always be downloaded from the support BBS or from
  820.         SaltAir BBS.  The number is at the top of this document.
  821.  
  822.  
  823.